<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>audio_formatter: xaudioformatter.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">audio_formatter
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xaudioformatter_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xaudioformatter.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p><b>Initialization &amp; Configuration</b> </p>
<p>The device driver enables higher layer software (e.g., an application) to communicate to the Audio Formatter core.</p>
<p><a class="el" href="group__audio__formatter.html#gaef1d64562a996ebb195cf2d6ef2f6ea7" title="This function initializes the audio formatter core instance. ">XAudioFormatter_CfgInitialize()</a> API is used to initialize the Audio Formatter core. The user needs to first call the <a class="el" href="group__audio__formatter.html#ga306c87bbfa3dfceed94dec4591465bf5" title="XAudioFormatter_LookupConfig returns a reference to an XAudioFormatter_Config structure based on the ...">XAudioFormatter_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="group__audio__formatter.html#gaef1d64562a996ebb195cf2d6ef2f6ea7" title="This function initializes the audio formatter core instance. ">XAudioFormatter_CfgInitialize()</a> API.</p>
<p><b> Interrupts </b> The driver does the interrupt handling, and dispatch to the user application through callback functions that user has registered.</p>
<p><b> Virtual Memory </b></p>
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
<p><b> Threads </b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b> Asserts </b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html">XAudioFormatter_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for a audio formatter core.  <a href="struct_x_audio_formatter___config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The audio formatter driver instance data structure.  <a href="struct_x_audio_formatter.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter_hw_params.html">XAudioFormatterHwParams</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains hw params information for a audio formatter core.  <a href="struct_x_audio_formatter_hw_params.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga73a0740e9df67c58f6ffa8dc6c40f26a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga73a0740e9df67c58f6ffa8dc6c40f26a">XAUDFMT_H_</a></td></tr>
<tr class="memdesc:ga73a0740e9df67c58f6ffa8dc6c40f26a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="group__audio__formatter.html#ga73a0740e9df67c58f6ffa8dc6c40f26a">More...</a><br/></td></tr>
<tr class="separator:ga73a0740e9df67c58f6ffa8dc6c40f26a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga306c87bbfa3dfceed94dec4591465bf5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_audio_formatter___config.html">XAudioFormatter_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga306c87bbfa3dfceed94dec4591465bf5">XAudioFormatter_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:ga306c87bbfa3dfceed94dec4591465bf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">XAudioFormatter_LookupConfig returns a reference to an <a class="el" href="struct_x_audio_formatter___config.html" title="This typedef contains configuration information for a audio formatter core. ">XAudioFormatter_Config</a> structure based on the unique device id, <em>DeviceId</em>.  <a href="group__audio__formatter.html#ga306c87bbfa3dfceed94dec4591465bf5">More...</a><br/></td></tr>
<tr class="separator:ga306c87bbfa3dfceed94dec4591465bf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef1d64562a996ebb195cf2d6ef2f6ea7"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#gaef1d64562a996ebb195cf2d6ef2f6ea7">XAudioFormatter_CfgInitialize</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, <a class="el" href="struct_x_audio_formatter___config.html">XAudioFormatter_Config</a> *CfgPtr)</td></tr>
<tr class="memdesc:gaef1d64562a996ebb195cf2d6ef2f6ea7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the audio formatter core instance.  <a href="group__audio__formatter.html#gaef1d64562a996ebb195cf2d6ef2f6ea7">More...</a><br/></td></tr>
<tr class="separator:gaef1d64562a996ebb195cf2d6ef2f6ea7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5779760c06dac849bd2e52ceded0ad65"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga5779760c06dac849bd2e52ceded0ad65">XAudioFormatter_InterruptEnable</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:ga5779760c06dac849bd2e52ceded0ad65"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables the interrupts for audio formatter core.  <a href="group__audio__formatter.html#ga5779760c06dac849bd2e52ceded0ad65">More...</a><br/></td></tr>
<tr class="separator:ga5779760c06dac849bd2e52ceded0ad65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c0f40a1f11f81c15f0bd0e1aea25d0a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga9c0f40a1f11f81c15f0bd0e1aea25d0a">XAudioFormatter_InterruptDisable</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:ga9c0f40a1f11f81c15f0bd0e1aea25d0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disables the interrupts for audio formatter core.  <a href="group__audio__formatter.html#ga9c0f40a1f11f81c15f0bd0e1aea25d0a">More...</a><br/></td></tr>
<tr class="separator:ga9c0f40a1f11f81c15f0bd0e1aea25d0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65ddaecacb3d843dade3da4a44862963"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga65ddaecacb3d843dade3da4a44862963">XAudioFormatterDMAStart</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga65ddaecacb3d843dade3da4a44862963"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function starts the dma for audio formatter core.  <a href="group__audio__formatter.html#ga65ddaecacb3d843dade3da4a44862963">More...</a><br/></td></tr>
<tr class="separator:ga65ddaecacb3d843dade3da4a44862963"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga95f19d9d0e20ad8b8bafcaf277ea1ca3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga95f19d9d0e20ad8b8bafcaf277ea1ca3">XAudioFormatterDMAStop</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga95f19d9d0e20ad8b8bafcaf277ea1ca3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function stops the dma for audio formatter core.  <a href="group__audio__formatter.html#ga95f19d9d0e20ad8b8bafcaf277ea1ca3">More...</a><br/></td></tr>
<tr class="separator:ga95f19d9d0e20ad8b8bafcaf277ea1ca3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0d2e42ac1ba8d83eca142032ad59320b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga0d2e42ac1ba8d83eca142032ad59320b">XAudioFormatterSetHwParams</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, <a class="el" href="struct_x_audio_formatter_hw_params.html">XAudioFormatterHwParams</a> *hw_params)</td></tr>
<tr class="memdesc:ga0d2e42ac1ba8d83eca142032ad59320b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the hw params for audio formatter core.  <a href="group__audio__formatter.html#ga0d2e42ac1ba8d83eca142032ad59320b">More...</a><br/></td></tr>
<tr class="separator:ga0d2e42ac1ba8d83eca142032ad59320b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6bf13816fa1c5fa913e85ec5734b7dcd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga6bf13816fa1c5fa913e85ec5734b7dcd">XAudioFormatter_InterruptClear</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u32 mask)</td></tr>
<tr class="memdesc:ga6bf13816fa1c5fa913e85ec5734b7dcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function clears the interrupts for audio formatter core.  <a href="group__audio__formatter.html#ga6bf13816fa1c5fa913e85ec5734b7dcd">More...</a><br/></td></tr>
<tr class="separator:ga6bf13816fa1c5fa913e85ec5734b7dcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga53384ac363365da9f8e31ed55cbf1d0b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga53384ac363365da9f8e31ed55cbf1d0b">XAudioFormatterDMAReset</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga53384ac363365da9f8e31ed55cbf1d0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function soft resets the audio formatter DMA core.  <a href="group__audio__formatter.html#ga53384ac363365da9f8e31ed55cbf1d0b">More...</a><br/></td></tr>
<tr class="separator:ga53384ac363365da9f8e31ed55cbf1d0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4e206855fe0fd0b43a40050d494b40f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#gae4e206855fe0fd0b43a40050d494b40f">XAudioFormatterSetFsMultiplier</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u32 Mclk, u32 Fs)</td></tr>
<tr class="memdesc:gae4e206855fe0fd0b43a40050d494b40f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function calculates the Fs multiplier value.  <a href="group__audio__formatter.html#gae4e206855fe0fd0b43a40050d494b40f">More...</a><br/></td></tr>
<tr class="separator:gae4e206855fe0fd0b43a40050d494b40f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc41edf6bcea2a85b50e8893016fb267"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#gabc41edf6bcea2a85b50e8893016fb267">XAudioFormatterGetDMATransferCount</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr)</td></tr>
<tr class="memdesc:gabc41edf6bcea2a85b50e8893016fb267"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the No.  <a href="group__audio__formatter.html#gabc41edf6bcea2a85b50e8893016fb267">More...</a><br/></td></tr>
<tr class="separator:gabc41edf6bcea2a85b50e8893016fb267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabec553226fe4cfd97f01d23b2c30bbad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#gabec553226fe4cfd97f01d23b2c30bbad">XSdiAud_GetChStat</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u8 *ChStatBuf)</td></tr>
<tr class="memdesc:gabec553226fe4cfd97f01d23b2c30bbad"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads all the Channel Status registers and writes to a buffer.  <a href="group__audio__formatter.html#gabec553226fe4cfd97f01d23b2c30bbad">More...</a><br/></td></tr>
<tr class="separator:gabec553226fe4cfd97f01d23b2c30bbad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6d1e04ada72ed2b53ee4c03809f8146e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga6d1e04ada72ed2b53ee4c03809f8146e">XAudioFormatterSetS2MMTimeOut</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u32 TimeOut)</td></tr>
<tr class="memdesc:ga6d1e04ada72ed2b53ee4c03809f8146e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the S2MM timeout.  <a href="group__audio__formatter.html#ga6d1e04ada72ed2b53ee4c03809f8146e">More...</a><br/></td></tr>
<tr class="separator:ga6d1e04ada72ed2b53ee4c03809f8146e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
